Skip to content

Tweak docs for Flex #8571

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 2, 2017
Merged

Tweak docs for Flex #8571

merged 1 commit into from
Nov 2, 2017

Conversation

fabpot
Copy link
Member

@fabpot fabpot commented Oct 31, 2017

I added a sentence about the new symfony.lock file and did some minor adjustments.

Copy link

@renatomefi renatomefi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm happy to see this documentation growing, I have same tiny suggestions if you are willing to check them!

by default, but it will still be optional to use.
as installing and removing bundles and other Composer dependencies. Symfony
Flex works for Symfony 3.3 and newer versions. Starting from Symfony 4.0, Flex
should be used by default, but it is optional to use.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be used by default, but it is optional to use.
I'd say:
should be used by default, but it is still optional.
To to avoid the double "used/use"

SwiftmailerBundle and returns the "recipe" for it.

Flex keeps tracks of which recipes it installed in a ``symfony.lock`` file that
must be committed in your code repository.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd rewrite to:
Flex keeps tracks of installed recipes in a ``symfony.lock`` file which must be committed in your code repository.
Just for better concordance

Symfony Flex as a dependency, so you can create a new Flex-enabled Symfony
application executing the following command:
project recommended to create new applications. This "skeleton" already
includes Symfony Flex as a dependency, so you can create a new Flex-enabled

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

, so you can create a new
to
, thus you can create a new

and directory created by this recipe.
remember names (``composer require mailer`` vs ``composer require
symfony/swiftmailer-bundle``). The ``bundles`` option tells Flex in which
environments should this bundle be enabled automatically (``all`` in this
Copy link

@jaikdean jaikdean Nov 1, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

environments should this bundle be enabled automatically should be environments this bundle should be automatically enabled

@weaverryan weaverryan merged commit 6d0d8f5 into symfony:3.3 Nov 2, 2017
weaverryan added a commit that referenced this pull request Nov 2, 2017
This PR was merged into the 3.3 branch.

Discussion
----------

Tweak docs for Flex

I added a sentence about the new `symfony.lock` file and did some minor adjustments.

Commits
-------

6d0d8f5 tweaked docs for Flex
weaverryan added a commit that referenced this pull request Nov 2, 2017
@weaverryan
Copy link
Member

Thanks for the review! I've made the suggested changes and merged :)

weaverryan added a commit that referenced this pull request Nov 5, 2017
* 3.3:
  more underlining!
  [#8571] Tweaks thanks to reviewers
  tweaked docs for Flex
  Update security.rst
  use .test instead of .dev as development domain
  Shortened command... easier to remember ;)
  Final updates
  Last fixes
  Restored the "Full Default Configuration" dump
  Fixed an indentation issue
  Simplified the framework configuration reference
  Added Doctrine entities and documents to the list of known locations for classes
weaverryan added a commit that referenced this pull request Nov 5, 2017
* 3.4:
  more underlining!
  [#8571] Tweaks thanks to reviewers
  tweaked docs for Flex
  Update security.rst
  use .test instead of .dev as development domain
  updating controller scalar args for 3.4
  Shortened command... easier to remember ;)
  Final updates
  Last fixes
  Restored the "Full Default Configuration" dump
  Fixed an indentation issue
  Simplified the framework configuration reference
  Added Doctrine entities and documents to the list of known locations for classes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants